<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Cache</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Cache</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cache controlling class</p>
<p class="description"><p>Class used to control the cache.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/_WikiPlot.php.html#functionRenderWikiPlot">RenderWikiPlot()</a></li>
				<li><span class="field">copyright:</span> Copyright 2006, WikiPlot development team.</li>
				<li><span class="field">author:</span> WikiPlot development team.</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.txt">GNU General Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_cache.class.php.html">/cache.class.php</a> (line <span class="field"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a41">41</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																				
												<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#CachePath" title="details" class="method-name">CachePath</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$FileName</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#CleanupCache" title="details" class="method-name">CleanupCache</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#CleanupMaxAge" title="details" class="method-name">CleanupMaxAge</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#CleanupUnused" title="details" class="method-name">CleanupUnused</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#FileExist" title="details" class="method-name">FileExist</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$FileName</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#FileURL" title="details" class="method-name">FileURL</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$FileName</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodCachePath" id="CachePath"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">CachePath</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a164">164</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get cache Path</p>
<p class="description"><p>Get absolute path to the cache, returns false if FileName exists.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Path to the cache, false if FileName exists.</li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/Cache.html#methodFileExist">Cache::FileExist()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			CachePath
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$FileName</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$FileName</span><span class="var-description">: Filename you want the path to, shortcut to detecting if file exists.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodCleanupCache" id="CleanupCache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">CleanupCache</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a52">52</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cleanup the cache</p>
<p class="description"><p>Cleans up the cache by removing old and unused files.</p></p>
	<ul class="tags">
				<li><span class="field">uses:</span> <a href="../WikiPlot/Cache.html#methodCleanupUnused">Cache::CleanupUnused()</a></li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/Cache.html#methodCleanupMaxAge">Cache::CleanupMaxAge()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			CleanupCache
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodCleanupMaxAge" id="CleanupMaxAge"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">CleanupMaxAge</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a65">65</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cleanup cache from old files</p>
<p class="description"><p>Removes old files from the cache, see LocalSettings.php for settings.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/Cache.html#methodCleanupCache">Cache::CleanupCache()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			CleanupMaxAge
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodCleanupUnused" id="CleanupUnused"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">CleanupUnused</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a97">97</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Cleanup unused files from cache</p>
<p class="description"><p>Removes old unused files from the cache, see LocalSettings.php for settings.  This functions indentifies files as unused if they havn't been accessed for a long time.</p></p>
	<ul class="tags">
				<li><span class="field">usedby:</span> <a href="../WikiPlot/Cache.html#methodCleanupCache">Cache::CleanupCache()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			CleanupUnused
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodFileExist" id="FileExist"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">FileExist</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a129">129</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Does file exist in cache</p>
<p class="description"><p>Returns true or false depending on whether or not FileName Exist in cache.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Whether or not FileName exist.</li>
				<li><span class="field">usedby:</span> <a href="../WikiPlot/Cache.html#methodCachePath">Cache::CachePath()</a></li>
				<li><span class="field">usedby:</span> <a href="../WikiPlot/Cache.html#methodFileURL">Cache::FileURL()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			FileExist
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$FileName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$FileName</span><span class="var-description">: Filename relative to cache.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodFileURL" id="FileURL"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">FileURL</span> (line <span class="line-number"><a href="../__filesource/fsource_WikiPlot__cache.class.php.html#a144">144</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get file URL</p>
<p class="description"><p>Gets the URL og the given FileName, returns false if the files doen't exist.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Returns the URL of the file.</li>
				<li><span class="field">uses:</span> <a href="../WikiPlot/Cache.html#methodFileExist">Cache::FileExist()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			FileURL
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$FileName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$FileName</span><span class="var-description">: Filename relative to cache.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Oct 2006 16:12:23 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
	</p>
	</div></body>
</html>